home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / opn_314.zip / OPN-D.ZIP / OPINION.DOC < prev    next >
Text File  |  1990-05-31  |  11KB  |  305 lines
  1.  
  2. Documentation for Opinion Poll
  3. ==============================
  4.  
  5. Opinion Poll is a simple door program that allows you to run opinion polls
  6. from your BBS and tabulate the results into a bulletin.  Opinion Poll may
  7. be executed in two different modes.  The first method is the general method.
  8. This method will support up to 12 simultaneous polls.  This method is executed
  9. with one of the following command lines:
  10.  
  11.                           OPINION
  12.                           OPINION node path bbs
  13.  
  14. The first line will run Opinion Poll in local mode.  The second line runs
  15. Opinion Poll in remote mode and the 'node' parameter represents the BBS node
  16. that is running, the 'path' is the full drive and path to your BBS files,
  17. and the 'bbs' is your BBS type as described below.
  18.  
  19. In this mode, Opinion Poll will scan the current directory for files of type
  20. '.POL'.  It will then present a list of up to 12 polls to select from.
  21.  
  22.  
  23. The second method of execution is the specific method.  This method will
  24. support an unlimited number or polls.  The command line for the second
  25. method is:
  26.  
  27.                         OPINION pollname
  28.                         OPINION node path bbs pollname
  29.  
  30. The first parameters are the same as above and the 'pollname' is the
  31. name of the poll definition file to run (.POL assumed).
  32.  
  33.  
  34. Well, I hope you enjoy the program.  If you have any questions or comments,
  35. please feel free to leave them on Mycroft Systems (408)927-0105.
  36.  
  37.  
  38. File list:
  39. ==========
  40.  
  41.         OPINION.DOC   -  This Document.
  42.         OPINION.BAT   -  DOORS execution file - general method (sample).
  43.         OPINION.EXE   -  The executible program (will run stand-alone).
  44.         OPINION.CFG   -  Opinion poll configuration file.
  45.         BBSUSE1.BAT   -  DOORS execution file - specific method (sample).
  46.         BBSUSE1.POL   -  Sample opinion poll of BBS features. (POLL)
  47.         BBSUSE2.BAT   -  DOORS execution file - specific method (sample).
  48.         BBSUSE2.POL   -  Sample opinion poll of BBS features. (SURVEY)
  49.         BBSUSE3.BAT   -  DOORS execution file - specific method (sample).
  50.         BBSUSE3.POL   -  Sample opinion poll of BBS features. (RATING)
  51.         NODES.BBS     -  A list of your comm port assignments by BBS node.
  52.         PORTS.BBS     -  Port definition file (optional & described within).
  53.  
  54.  
  55.  
  56. Program history:
  57. ================
  58.  
  59. 06/88   Version 1.00  -  Initial version
  60. 08/88   Version 2.00  -  Allows each user to only vote once per poll
  61. 09/88   Version 2.01  -  Returns to poll menu after voting on poll
  62. 11/88   Version 2.02  -  WWIV & PCBoard 14 support added
  63. 09/89   Version 2.30  -  Spitfire support
  64. 10/89   Version 3.00  -  Switched from POLL only type to POLL, SURVEY, RATING
  65. 06/90   Version 3.10  -  New int I/O routines. view poll results, help
  66.  
  67.  
  68. Config File Format:
  69. ===================
  70.  
  71. The following is the format of the OPINION.CFG file:
  72.  
  73.       Line 1  - Name of your BBS.
  74.       Line 2  - SysOps name.
  75.       Line 3  - Maximum time user may spend in opinion (in minutes).
  76.  
  77.  
  78. BBS Specific Operation:
  79. =======================
  80.  
  81. Opinion supports the follow BBS type parameters:
  82.  
  83.       RBBS15    for RBBS 15.x
  84.       RBBS      for RBBS 16.1 or newer
  85.       QBBS      for Quick BBS
  86.       PCBOARD   for PC-Board 12.1
  87.       PCBOARD14 for PC-Board 14.x
  88.       WILDCAT   for Wildcat BBS
  89.       GAP       for GAP BBS
  90.       WWIV      for WWIV BBS
  91.       SPITFIRE  for Spitfire BBS (door)
  92.       SPITFIREK for Spitfire BBS (Main Menu User Command)
  93.       SPITFIREM for Spitfire BBS (Message Menu User Command)
  94.       SPITFIREF for Spitfire BBS (File Menu User Command)
  95.  
  96.  
  97. Assumed RBBS 16.x files:
  98. ------------------------
  99.  
  100. Opinion assumes that the following files are in the directory specified
  101. by the path parameter when running directly under RBBS 16.x:
  102.  
  103.         NODES.BBS       Node definition file.
  104.  
  105.         MESSAGES        This file contains the information pertaining
  106.                         to each node on the BBS.
  107.  
  108.         DORINFOx.DEF    This file contains all of the users settings
  109.                         such as graphics, parity, baud rate, etc.
  110.  
  111.  
  112. Assumed RBBS 15.x files:
  113. ------------------------
  114.  
  115. Opinion assumes that the following files are in the directory specified
  116. by the path parameter when running directly under RBBS 15.x:
  117.  
  118.         NODES.BBS       Node definition file.
  119.  
  120.         MESSAGES        This file contains the information pertaining
  121.                         to each node on the BBS.
  122.  
  123.         USERS           This file contains all of the users settings
  124.                         such as graphics, parity, baud rate, etc.
  125.  
  126.         PASSWRDS        This file MUST contain an entry for each security
  127.                         level allowed to run doors.  Opinion gets the
  128.                         users daily time limit from this file.
  129.  
  130.  
  131. Assumed Quick BBS files:
  132. ========================
  133.  
  134. Opinion assumes that the following files are in the directory specified
  135. by the path parameter when running directly under Quick BBS:
  136.  
  137.         NODES.BBS       Node definition file.
  138.  
  139.         DORINFOx.DEF    This file contains all of the users settings
  140.                         such as graphics, parity, baud rate, etc.
  141.  
  142.  
  143. Assumed PC-BOARD files:
  144. =======================
  145.  
  146. Opinion assumes that the following files are in the directory specified
  147. by the path parameter when running directly under PC-Board:
  148.  
  149.         NODES.BBS       Node definition file.
  150.  
  151.         PCBOARD.SYS     This file contains the information pertaining
  152.                         to the BBS node and the callers information.
  153.  
  154.  
  155.  
  156. Assumed Wildcat files:
  157. ======================
  158.  
  159. Opinion assumes that the following files are in the directory specified
  160. by the path parameter when running directly under Wildcat:
  161.  
  162.         NODES.BBS       Node definition file.
  163.  
  164.         CALLINFO.BBS    This file contains all of the users settings
  165.                         such as graphics, parity, baud rate, etc.
  166.  
  167.  
  168.  
  169. Assumed GAP files:
  170. ==================
  171.  
  172. Opinion assumes that the following files are in the directory specified
  173. by the path parameter when running directly under GAP:
  174.  
  175.         NODES.BBS       Node definition file.
  176.  
  177.         DOOR.SYS        This file contains all of the users settings
  178.                         such as graphics, parity, baud rate, etc.
  179.  
  180.  
  181.  
  182. Assumed WWIV files:
  183. ===================
  184.  
  185. Opinion assumes that the following files are in the directory specified
  186. by the path parameter when running directly under WWIV:
  187.  
  188.         NODES.BBS       Node definition file.
  189.  
  190.         CHAIN.TXT       This file contains all of the users settings
  191.                         such as graphics, parity, baud rate, etc.
  192.  
  193.  
  194.  
  195. Assumed Spitfire files:
  196. =======================
  197.  
  198. Opinion assumes that the following files are in the directory specified
  199. by the path parameter when running directly under Spitfire:
  200.  
  201.         NODES.BBS       Node definition file.
  202.  
  203.       * SFDOORS.DAT     This file contains all of the users settings
  204.                         such as graphics, parity, baud rate, etc.
  205.  
  206.       * SFMAIN.DAT      This file contains all of the users settings
  207.                         such as graphics, parity, baud rate, etc.
  208.  
  209.       * SFMESS.DAT      This file contains all of the users settings
  210.                         such as graphics, parity, baud rate, etc.
  211.  
  212.       * SFFILE.DAT      This file contains all of the users settings
  213.                         such as graphics, parity, baud rate, etc.
  214.  
  215. * Note only one of these files is required.  Will depend on the environment
  216. you select.
  217.  
  218.  
  219. Writing new polls:
  220. ==================
  221.  
  222. The following section will describe how to write new polls.  The file
  223. BBS_USE.POL may be used as an example.  All poll files are assumed to be
  224. of extesion '.POL'.  Opinion Poll will create an associated data file of
  225. the same name and of extension '.DAT'.  Each poll definition file must
  226. contain at least 15 lines.  Anything past line 15 will be ignored and may
  227. be used for a comment area.  The following is a definition on a line by line
  228. basis for the poll definition file:
  229.  
  230.       Line 1  - Title of poll.
  231.       Line 2  - Poll type.
  232.       Line 3  - Name of bulletin output file for results
  233.       Line 4  - Question line 1
  234.       Line 5  - Question line 2
  235.       Line 6  - Question line 3
  236.       Line 7  - Question line 4
  237.       Line 8  - Option line 1
  238.       Line 9  - Option line 2
  239.       Line 10 - Option line 3
  240.       Line 11 - Option line 4
  241.       Line 12 - Option line 5
  242.       Line 13 - Option line 6
  243.       Line 14 - Option line 7
  244.       Line 15 - Option line 8
  245.  
  246. The poll title main be up to 78 characters long.  The poll type must be
  247. POLL for a select one type poll, SURVEY for select as many as desired poll,
  248. or RATING for rate each as 0-10 poll.  The bulletin output file name
  249. should specify a complete path of where to write the opinion poll results
  250. You may have from 1 to 4 lines for your question.  These should be around
  251. 70 characters in lenght to center well.  Unused question lines must be
  252. left blank.  You may have from 1 to 8 options for your users to select
  253. from.  These may be up to 70 chars in lenght, but will be truncated to a
  254. maximum of 36 characters for output to the bulletin.  Unused option lines
  255. must be blank.
  256.  
  257.  
  258. SysOp controls:
  259. ===============
  260.  
  261. The SysOp has similar controls as to those provided in RBBS.  The following
  262. set of functions are available:
  263.  
  264.     Alt F1      This key will eject the current user from the game
  265.                 by setting all his door access time to consumed.
  266.  
  267.     Right Arrow This key will add 1 minute of door access time to
  268.                 the current users current door session.
  269.  
  270.     Left Arrow  This key will subtract 1 minute of door access time
  271.                 from the current users current door session.
  272.  
  273.         F4      The F4 key will toggle the state of the SysOp
  274.                 annoy toggle.  Note that it is reset to its
  275.                 original state when RBBS is reentered.
  276.  
  277.         F6      The F6 key will toggle the state of the SysOp
  278.                 availability toggle.  Note that it is reset to
  279.                 its original state when RBBS is reentered.
  280.  
  281.         F9      The F9 key will toggle the state of the SysOp
  282.                 snoop toggle.  Note that it is reset to its
  283.                 original state when RBBS is reentered.
  284.  
  285.         F10     The F10 key is used to initiate CHAT mode.  This
  286.                 allows the SysOp to converse with the user via the
  287.                 keyboard.
  288.  
  289.         ESC     The escape key is used to answer a user page.  It
  290.                 is also used to terminate CHAT mode.
  291.  
  292.  
  293. Epilog:
  294. =======
  295.  
  296. Please enjoy the program and feel free to contact Mycroft Systems BBS if
  297. you have any questions.
  298.  
  299.                                                 Thanks,
  300.  
  301.                                                 Michael W. Bayley
  302.                                                 Mycroft Systems
  303.                                                 (408)927-0105
  304.  
  305.